home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 3.iso / dist / fw_texinfo.idb / usr / freeware / info / texinfo-12.z / texinfo-12
Text File  |  2001-07-06  |  40KB  |  860 lines

  1. This is texinfo, produced by makeinfo version 4.0 from texinfo.txi.
  2.  
  3. INFO-DIR-SECTION Texinfo documentation system
  4. START-INFO-DIR-ENTRY
  5. * Texinfo: (texinfo).           The GNU documentation format.
  6. * install-info: (texinfo)Invoking install-info. Update info/dir entries.
  7. * texi2dvi: (texinfo)Format with texi2dvi.      Print Texinfo documents.
  8. * texindex: (texinfo)Format with tex/texindex.  Sort Texinfo index files.
  9. * makeinfo: (texinfo)makeinfo Preferred.        Translate Texinfo source.
  10. END-INFO-DIR-ENTRY
  11.  
  12.   This file documents Texinfo, a documentation system that can produce
  13. both online information and a printed manual from a single source file.
  14.  
  15.   Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99 Free Software
  16. Foundation, Inc.
  17.  
  18.   This edition is for Texinfo version 4.0, 28 September 1999.
  19.  
  20.   Permission is granted to make and distribute verbatim copies of this
  21. manual provided the copyright notice and this permission notice are
  22. preserved on all copies.
  23.  
  24.   Permission is granted to copy and distribute modified versions of this
  25. manual under the conditions for verbatim copying, provided that the
  26. entire resulting derived work is distributed under the terms of a
  27. permission notice identical to this one.
  28.  
  29.   Permission is granted to copy and distribute translations of this
  30. manual into another language, under the above conditions for modified
  31. versions, except that this permission notice may be stated in a
  32. translation approved by the Free Software Foundation.
  33.  
  34. 
  35. File: texinfo,  Node: Debugging with TeX,  Next: Using texinfo-show-structure,  Prev: Debugging with Info,  Up: Catching Mistakes
  36.  
  37. Catching Errors with TeX Formatting
  38. ===================================
  39.  
  40.   You can also catch mistakes when you format a file with TeX.
  41.  
  42.   Usually, you will want to do this after you have run
  43. `texinfo-format-buffer' (or, better, `makeinfo-buffer') on the same
  44. file, because `texinfo-format-buffer' sometimes displays error messages
  45. that make more sense than TeX.  (*Note Debugging with Info::, for more
  46. information.)
  47.  
  48.   For example, TeX was run on a Texinfo file, part of which is shown
  49. here:
  50.  
  51.      ---------- Buffer: texinfo.texi ----------
  52.      name of the Texinfo file as an extension.  The
  53.      @samp{??} are `wildcards' that cause the shell to
  54.      substitute all the raw index files.  (@xref{sorting
  55.      indices, for more information about sorting
  56.      indices.)@refill
  57.      ---------- Buffer: texinfo.texi ----------
  58.  
  59. (The cross reference lacks a closing brace.)  TeX produced the
  60. following output, after which it stopped:
  61.  
  62.      ---------- Buffer: *tex-shell* ----------
  63.      Runaway argument?
  64.      {sorting indices, for more information about sorting
  65.      indices.) @refill @ETC.
  66.      ! Paragraph ended before @xref was complete.
  67.      <to be read again>
  68.                         @par
  69.      l.27
  70.      
  71.      ?
  72.      ---------- Buffer: *tex-shell* ----------
  73.  
  74.   In this case, TeX produced an accurate and understandable error
  75. message:
  76.  
  77.      Paragraph ended before @xref was complete.
  78.  
  79. `@par' is an internal TeX command of no relevance to Texinfo.  `l.27'
  80. means that TeX detected the problem on line 27 of the Texinfo file.
  81. The `?' is the prompt TeX uses in this circumstance.
  82.  
  83.   Unfortunately, TeX is not always so helpful, and sometimes you must
  84. truly be a Sherlock Holmes to discover what went wrong.
  85.  
  86.   In any case, if you run into a problem like this, you can do one of
  87. three things.
  88.  
  89.   1. You can tell TeX to continue running and ignore just this error by
  90.      typing <RET> at the `?' prompt.
  91.  
  92.   2. You can tell TeX to continue running and to ignore all errors as
  93.      best it can by typing `r <RET>' at the `?' prompt.
  94.  
  95.      This is often the best thing to do.  However, beware: the one error
  96.      may produce a cascade of additional error messages as its
  97.      consequences are felt through the rest of the file.  To stop TeX
  98.      when it is producing such an avalanche of error messages, type
  99.      `C-c' (or `C-c C-c', if you are running a shell inside Emacs).
  100.  
  101.   3. You can tell TeX to stop this run by typing `x <RET>' at the `?'
  102.      prompt.
  103.  
  104.   If you are running TeX inside Emacs, you need to switch to the shell
  105. buffer and line at which TeX offers the `?' prompt.
  106.  
  107.   Sometimes TeX will format a file without producing error messages even
  108. though there is a problem.  This usually occurs if a command is not
  109. ended but TeX is able to continue processing anyhow.  For example, if
  110. you fail to end an itemized list with the `@end itemize' command, TeX
  111. will write a DVI file that you can print out.  The only error message
  112. that TeX will give you is the somewhat mysterious comment that
  113.  
  114.      (@end occurred inside a group at level 1)
  115.  
  116. However, if you print the DVI file, you will find that the text of the
  117. file that follows the itemized list is entirely indented as if it were
  118. part of the last item in the itemized list.  The error message is the
  119. way TeX says that it expected to find an `@end' command somewhere in
  120. the file; but that it could not determine where it was needed.
  121.  
  122.   Another source of notoriously hard-to-find errors is a missing `@end
  123. group' command.  If you ever are stumped by incomprehensible errors,
  124. look for a missing `@end group' command first.
  125.  
  126.   If the Texinfo file lacks header lines, TeX may stop in the beginning
  127. of its run and display output that looks like the following.  The `*'
  128. indicates that TeX is waiting for input.
  129.  
  130.      This is TeX, Version 3.14159 (Web2c 7.0)
  131.      (test.texinfo [1])
  132.      *
  133.  
  134. In this case, simply type `\end <RET>' after the asterisk.  Then write
  135. the header lines in the Texinfo file and run the TeX command again.
  136. (Note the use of the backslash, `\'.  TeX uses `\' instead of `@'; and
  137. in this circumstance, you are working directly with TeX, not with
  138. Texinfo.)
  139.  
  140. 
  141. File: texinfo,  Node: Using texinfo-show-structure,  Next: Using occur,  Prev: Debugging with TeX,  Up: Catching Mistakes
  142.  
  143. Using `texinfo-show-structure'
  144. ==============================
  145.  
  146.   It is not always easy to keep track of the nodes, chapters, sections,
  147. and subsections of a Texinfo file.  This is especially true if you are
  148. revising or adding to a Texinfo file that someone else has written.
  149.  
  150.   In GNU Emacs, in Texinfo mode, the `texinfo-show-structure' command
  151. lists all the lines that begin with the @-commands that specify the
  152. structure: `@chapter', `@section', `@appendix', and so on.  With an
  153. argument (`C-u' as prefix argument, if interactive), the command also
  154. shows the `@node' lines.  The `texinfo-show-structure' command is bound
  155. to `C-c C-s' in Texinfo mode, by default.
  156.  
  157.   The lines are displayed in a buffer called the `*Occur*' buffer,
  158. indented by hierarchical level.  For example, here is a part of what was
  159. produced by running `texinfo-show-structure' on this manual:
  160.  
  161.       Lines matching "^@\\(chapter \\|sect\\|subs\\|subh\\|
  162.       unnum\\|major\\|chapheading \\|heading \\|appendix\\)"
  163.       in buffer texinfo.texi.
  164.       ...
  165.       4177:@chapter Nodes
  166.       4198:    @heading Two Paths
  167.       4231:    @section Node and Menu Illustration
  168.       4337:    @section The @code{@@node} Command
  169.       4393:        @subheading Choosing Node and Pointer Names
  170.       4417:        @subsection How to Write an @code{@@node} Line
  171.       4469:        @subsection @code{@@node} Line Tips
  172.       ...
  173.  
  174.   This says that lines 4337, 4393, and 4417 of `texinfo.texi' begin
  175. with the `@section', `@subheading', and `@subsection' commands
  176. respectively.  If you move your cursor into the `*Occur*' window, you
  177. can position the cursor over one of the lines and use the `C-c C-c'
  178. command (`occur-mode-goto-occurrence'), to jump to the corresponding
  179. spot in the Texinfo file.  *Note Using Occur: (emacs)Other Repeating
  180. Search, for more information about `occur-mode-goto-occurrence'.
  181.  
  182.   The first line in the `*Occur*' window describes the "regular
  183. expression" specified by TEXINFO-HEADING-PATTERN.  This regular
  184. expression is the pattern that `texinfo-show-structure' looks for.
  185. *Note Using Regular Expressions: (emacs)Regexps, for more information.
  186.  
  187.   When you invoke the `texinfo-show-structure' command, Emacs will
  188. display the structure of the whole buffer.  If you want to see the
  189. structure of just a part of the buffer, of one chapter, for example,
  190. use the `C-x n n' (`narrow-to-region') command to mark the region.
  191. (*Note Narrowing: (emacs)Narrowing.)  This is how the example used
  192. above was generated.  (To see the whole buffer again, use `C-x n w'
  193. (`widen').)
  194.  
  195.   If you call `texinfo-show-structure' with a prefix argument by typing
  196. `C-u C-c C-s', it will list lines beginning with `@node' as well as the
  197. lines beginning with the @-sign commands for `@chapter', `@section',
  198. and the like.
  199.  
  200.   You can remind yourself of the structure of a Texinfo file by looking
  201. at the list in the `*Occur*' window; and if you have mis-named a node
  202. or left out a section, you can correct the mistake.
  203.  
  204. 
  205. File: texinfo,  Node: Using occur,  Next: Running Info-Validate,  Prev: Using texinfo-show-structure,  Up: Catching Mistakes
  206.  
  207. Using `occur'
  208. =============
  209.  
  210.   Sometimes the `texinfo-show-structure' command produces too much
  211. information.  Perhaps you want to remind yourself of the overall
  212. structure of a Texinfo file, and are overwhelmed by the detailed list
  213. produced by `texinfo-show-structure'.  In this case, you can use the
  214. `occur' command directly.  To do this, type
  215.  
  216.      M-x occur
  217.  
  218. and then, when prompted, type a "regexp", a regular expression for the
  219. pattern you want to match.  (*Note Regular Expressions:
  220. (emacs)Regexps.)  The `occur' command works from the current location
  221. of the cursor in the buffer to the end of the buffer.  If you want to
  222. run `occur' on the whole buffer, place the cursor at the beginning of
  223. the buffer.
  224.  
  225.   For example, to see all the lines that contain the word `@chapter' in
  226. them, just type `@chapter'.  This will produce a list of the chapters.
  227. It will also list all the sentences with `@chapter' in the middle of
  228. the line.
  229.  
  230.   If you want to see only those lines that start with the word
  231. `@chapter', type `^@chapter' when prompted by `occur'.  If you want to
  232. see all the lines that end with a word or phrase, end the last word
  233. with a `$'; for example, `catching mistakes$'.  This can be helpful
  234. when you want to see all the nodes that are part of the same chapter or
  235. section and therefore have the same `Up' pointer.
  236.  
  237.   *Note Using Occur: (emacs)Other Repeating Search, for more
  238. information.
  239.  
  240. 
  241. File: texinfo,  Node: Running Info-Validate,  Prev: Using occur,  Up: Catching Mistakes
  242.  
  243. Finding Badly Referenced Nodes
  244. ==============================
  245.  
  246.   You can use the `Info-validate' command to check whether any of the
  247. `Next', `Previous', `Up' or other node pointers fail to point to a
  248. node.  This command checks that every node pointer points to an
  249. existing node.  The `Info-validate' command works only on Info files,
  250. not on Texinfo files.
  251.  
  252.   The `makeinfo' program validates pointers automatically, so you do
  253. not need to use the `Info-validate' command if you are using
  254. `makeinfo'.  You only may need to use `Info-validate' if you are unable
  255. to run `makeinfo' and instead must create an Info file using
  256. `texinfo-format-region' or `texinfo-format-buffer', or if you write an
  257. Info file from scratch.
  258.  
  259. * Menu:
  260.  
  261. * Using Info-validate::         How to run `Info-validate'.
  262. * Unsplit::                     How to create an unsplit file.
  263. * Tagifying::                   How to tagify a file.
  264. * Splitting::                   How to split a file manually.
  265.  
  266. 
  267. File: texinfo,  Node: Using Info-validate,  Next: Unsplit,  Prev: Running Info-Validate,  Up: Running Info-Validate
  268.  
  269. Running `Info-validate'
  270. -----------------------
  271.  
  272.   To use `Info-validate', visit the Info file you wish to check and
  273. type:
  274.  
  275.      M-x Info-validate
  276.  
  277. Note that the `Info-validate' command requires an upper case `I'.  You
  278. may also need to create a tag table before running `Info-validate'.
  279. *Note Tagifying::.
  280.  
  281.   If your file is valid, you will receive a message that says "File
  282. appears valid".  However, if you have a pointer that does not point to
  283. a node, error messages will be displayed in a buffer called `*problems
  284. in info file*'.
  285.  
  286.   For example, `Info-validate' was run on a test file that contained
  287. only the first node of this manual.  One of the messages said:
  288.  
  289.      In node "Overview", invalid Next: Texinfo Mode
  290.  
  291. This meant that the node called `Overview' had a `Next' pointer that
  292. did not point to anything (which was true in this case, since the test
  293. file had only one node in it).
  294.  
  295.   Now suppose we add a node named `Texinfo Mode' to our test case but
  296. we do not specify a `Previous' for this node.  Then we will get the
  297. following error message:
  298.  
  299.      In node "Texinfo Mode", should have Previous: Overview
  300.  
  301. This is because every `Next' pointer should be matched by a `Previous'
  302. (in the node where the `Next' points) which points back.
  303.  
  304.   `Info-validate' also checks that all menu entries and cross references
  305. point to actual nodes.
  306.  
  307.   `Info-validate' requires a tag table and does not work with files
  308. that have been split.  (The `texinfo-format-buffer' command
  309. automatically splits large files.)  In order to use `Info-validate' on
  310. a large file, you must run `texinfo-format-buffer' with an argument so
  311. that it does not split the Info file; and you must create a tag table
  312. for the unsplit file.
  313.  
  314. 
  315. File: texinfo,  Node: Unsplit,  Next: Tagifying,  Prev: Using Info-validate,  Up: Running Info-Validate
  316.  
  317. Creating an Unsplit File
  318. ------------------------
  319.  
  320.   You can run `Info-validate' only on a single Info file that has a tag
  321. table.  The command will not work on the indirect subfiles that are
  322. generated when a master file is split.  If you have a large file
  323. (longer than 70,000 bytes or so), you need to run the
  324. `texinfo-format-buffer' or `makeinfo-buffer' command in such a way that
  325. it does not create indirect subfiles.  You will also need to create a
  326. tag table for the Info file.  After you have done this, you can run
  327. `Info-validate' and look for badly referenced nodes.
  328.  
  329.   The first step is to create an unsplit Info file.  To prevent
  330. `texinfo-format-buffer' from splitting a Texinfo file into smaller Info
  331. files, give a prefix to the `M-x texinfo-format-buffer' command:
  332.  
  333.      C-u M-x texinfo-format-buffer
  334.  
  335. or else
  336.  
  337.      C-u C-c C-e C-b
  338.  
  339. When you do this, Texinfo will not split the file and will not create a
  340. tag table for it.
  341.  
  342. 
  343. File: texinfo,  Node: Tagifying,  Next: Splitting,  Prev: Unsplit,  Up: Running Info-Validate
  344.  
  345. Tagifying a File
  346. ----------------
  347.  
  348.   After creating an unsplit Info file, you must create a tag table for
  349. it.  Visit the Info file you wish to tagify and type:
  350.  
  351.      M-x Info-tagify
  352.  
  353. (Note the upper case `I' in `Info-tagify'.)  This creates an Info file
  354. with a tag table that you can validate.
  355.  
  356.   The third step is to validate the Info file:
  357.  
  358.      M-x Info-validate
  359.  
  360. (Note the upper case `I' in `Info-validate'.)  In brief, the steps are:
  361.  
  362.      C-u M-x texinfo-format-buffer
  363.      M-x Info-tagify
  364.      M-x Info-validate
  365.  
  366.   After you have validated the node structure, you can rerun
  367. `texinfo-format-buffer' in the normal way so it will construct a tag
  368. table and split the file automatically, or you can make the tag table
  369. and split the file manually.
  370.  
  371. 
  372. File: texinfo,  Node: Splitting,  Prev: Tagifying,  Up: Running Info-Validate
  373.  
  374. Splitting a File Manually
  375. -------------------------
  376.  
  377.   You should split a large file or else let the `texinfo-format-buffer'
  378. or `makeinfo-buffer' command do it for you automatically.  (Generally
  379. you will let one of the formatting commands do this job for you.  *Note
  380. Creating an Info File::.)
  381.  
  382.   The split-off files are called the indirect subfiles.
  383.  
  384.   Info files are split to save memory.  With smaller files, Emacs does
  385. not have make such a large buffer to hold the information.
  386.  
  387.   If an Info file has more than 30 nodes, you should also make a tag
  388. table for it. *Note Using Info-validate::, for information about
  389. creating a tag table.  (Again, tag tables are usually created
  390. automatically by the formatting command; you only need to create a tag
  391. table yourself if you are doing the job manually.  Most likely, you
  392. will do this for a large, unsplit file on which you have run
  393. `Info-validate'.)
  394.  
  395.   Visit the Info file you wish to tagify and split and type the two
  396. commands:
  397.  
  398.      M-x Info-tagify
  399.      M-x Info-split
  400.  
  401. (Note that the `I' in `Info' is upper case.)
  402.  
  403.   When you use the `Info-split' command, the buffer is modified into a
  404. (small) Info file which lists the indirect subfiles.  This file should
  405. be saved in place of the original visited file.  The indirect subfiles
  406. are written in the same directory the original file is in, with names
  407. generated by appending `-' and a number to the original file name.
  408.  
  409.   The primary file still functions as an Info file, but it contains just
  410. the tag table and a directory of subfiles.
  411.  
  412. 
  413. File: texinfo,  Node: Refilling Paragraphs,  Next: Command Syntax,  Prev: Catching Mistakes,  Up: Top
  414.  
  415. Refilling Paragraphs
  416. ********************
  417.  
  418.   The `@refill' command refills and, optionally, indents the first line
  419. of a paragraph.(1) (*note Refilling Paragraphs-Footnote-1::) The
  420. `@refill' command is no longer important, but we describe it here
  421. because you once needed it.  You will see it in many old Texinfo files.
  422.  
  423.   Without refilling, paragraphs containing long @-constructs may look
  424. bad after formatting because the formatter removes @-commands and
  425. shortens some lines more than others.  In the past, neither the
  426. `texinfo-format-region' command nor the `texinfo-format-buffer' command
  427. refilled paragraphs automatically.  The `@refill' command had to be
  428. written at the end of every paragraph to cause these formatters to fill
  429. them.  (Both TeX and `makeinfo' have always refilled paragraphs
  430. automatically.)  Now, all the Info formatters automatically fill and
  431. indent those paragraphs that need to be filled and indented.
  432.  
  433.   The `@refill' command causes `texinfo-format-region' and
  434. `texinfo-format-buffer' to refill a paragraph in the Info file _after_
  435. all the other processing has been done.  For this reason, you can not
  436. use `@refill' with a paragraph containing either `@*' or `@w{ ... }'
  437. since the refilling action will override those two commands.
  438.  
  439.   The `texinfo-format-region' and `texinfo-format-buffer' commands now
  440. automatically append `@refill' to the end of each paragraph that should
  441. be filled.  They do not append `@refill' to the ends of paragraphs that
  442. contain `@*' or `@w{ ...}' and therefore do not refill or indent them.
  443.  
  444. 
  445. File: texinfo,  Node: Refilling Paragraphs-Footnotes,  Up: Refilling Paragraphs
  446.  
  447.   (1) Perhaps the command should have been called the
  448. `@refillandindent' command, but `@refill' is shorter and the name was
  449. chosen before indenting was possible.
  450.  
  451. 
  452. File: texinfo,  Node: Command Syntax,  Next: Obtaining TeX,  Prev: Refilling Paragraphs,  Up: Top
  453.  
  454. @-Command Syntax
  455. ****************
  456.  
  457.   The character `@' is used to start special Texinfo commands.  (It has
  458. the same meaning that `\' has in plain TeX.)  Texinfo has four types of
  459. @-command:
  460.  
  461. 1. Non-alphabetic commands.
  462.      These commands consist of an @ followed by a punctuation mark or
  463.      other character that is not part of the alphabet.  Non-alphabetic
  464.      commands are almost always part of the text within a paragraph,
  465.      and never take any argument.  The two characters (@ and the other
  466.      one) are complete in themselves; none is followed by braces.  The
  467.      non-alphabetic commands are: `@.', `@:', `@*', `@SPACE', `@TAB',
  468.      `@NL', `@@', `@{', and `@}'.
  469.  
  470. 2. Alphabetic commands that do not require arguments.
  471.      These commands start with @ followed by a word followed by left-
  472.      and right-hand braces.  These commands insert special symbols in
  473.      the document; they do not require arguments.  For example,
  474.      `@dots{}' => `...', `@equiv{}' => `==', `@TeX{}' => `TeX', and
  475.      `@bullet{}' => `*'.
  476.  
  477. 3. Alphabetic commands that require arguments within braces.
  478.      These commands start with @ followed by a letter or a word,
  479.      followed by an argument within braces.  For example, the command
  480.      `@dfn' indicates the introductory or defining use of a term; it is
  481.      used as follows: `In Texinfo, @@-commands are @dfn{mark-up}
  482.      commands.'
  483.  
  484. 4. Alphabetic commands that occupy an entire line.
  485.      These commands occupy an entire line.  The line starts with @,
  486.      followed by the name of the command (a word); for example,
  487.      `@center' or `@cindex'.  If no argument is needed, the word is
  488.      followed by the end of the line.  If there is an argument, it is
  489.      separated from the command name by a space.  Braces are not used.
  490.  
  491.   Thus, the alphabetic commands fall into classes that have different
  492. argument syntaxes.  You cannot tell to which class a command belongs by
  493. the appearance of its name, but you can tell by the command's meaning:
  494. if the command stands for a glyph, it is in class 2 and does not
  495. require an argument; if it makes sense to use the command together with
  496. other text as part of a paragraph, the command is in class 3 and must
  497. be followed by an argument in braces; otherwise, it is in class 4 and
  498. uses the rest of the line as its argument.
  499.  
  500.   The purpose of having a different syntax for commands of classes 3 and
  501. 4 is to make Texinfo files easier to read, and also to help the GNU
  502. Emacs paragraph and filling commands work properly.  There is only one
  503. exception to this rule: the command `@refill', which is always used at
  504. the end of a paragraph immediately following the final period or other
  505. punctuation character.  `@refill' takes no argument and does _not_
  506. require braces.  `@refill' never confuses the Emacs paragraph commands
  507. because it cannot appear at the beginning of a line.
  508.  
  509. 
  510. File: texinfo,  Node: Obtaining TeX,  Next: Command and Variable Index,  Prev: Command Syntax,  Up: Top
  511.  
  512. How to Obtain TeX
  513. *****************
  514.  
  515.   TeX is freely redistributable.  You can obtain TeX for Unix systems
  516. via anonymous ftp or on physical media.  The core material consists of
  517. the Web2c TeX distribution (`http://tug.org/web2c').
  518.  
  519.   Instructions for retrieval by anonymous ftp and information on other
  520. available distributions:
  521.      `ftp://tug.org/tex/unixtex.ftp'
  522.      `http://tug.org/unixtex.ftp'
  523.  
  524.   The Free Software Foundation provides a core distribution on its
  525. Source Code CD-ROM suitable for printing Texinfo manuals.  To order it,
  526. contact:
  527.  
  528.      Free Software Foundation, Inc.
  529.      59 Temple Place Suite 330
  530.      Boston, MA   02111-1307
  531.      USA
  532.      Telephone: +1-617-542-5942
  533.      Fax: (including Japan) +1-617-542-2652
  534.      Free Dial Fax (in Japan):
  535.            0031-13-2473 (KDD)
  536.            0066-3382-0158 (IDC)
  537.      Electronic mail: `gnu@gnu.org'
  538.  
  539.   Many other TeX distributions are available; see `http://tug.org/'.
  540.  
  541. 
  542. File: texinfo,  Node: Command and Variable Index,  Next: Concept Index,  Prev: Obtaining TeX,  Up: Top
  543.  
  544. Command and Variable Index
  545. **************************
  546.  
  547.   This is an alphabetical list of all the @-commands, assorted Emacs
  548. Lisp functions, and several variables.  To make the list easier to use,
  549. the commands are listed without their preceding `@'.
  550.  
  551. * Menu:
  552.  
  553. * ! (end of sentence):                   Ending a Sentence.
  554. * ":                                     Inserting Accents.
  555. * ':                                     Inserting Accents.
  556. * (newline):                             Multiple Spaces.
  557. * (space):                               Multiple Spaces.
  558. * (tab):                                 Multiple Spaces.
  559. * * (force line break):                  Line Breaks.
  560. * ,:                                     Inserting Accents.
  561. * -:                                     - and hyphenation.
  562. * .  (end of sentence):                  Ending a Sentence.
  563. * : (suppress widening):                 Not Ending a Sentence.
  564. * =:                                     Inserting Accents.
  565. * ? (end of sentence):                   Ending a Sentence.
  566. * @ (single @):                          Inserting An Atsign.
  567. * \emergencystretch:                     Overfull hboxes.
  568. * ^:                                     Inserting Accents.
  569. * `:                                     Inserting Accents.
  570. * AA:                                    Inserting Accents.
  571. * aa:                                    Inserting Accents.
  572. * acronym:                               acronym.
  573. * ae:                                    Inserting Accents.
  574. * AE:                                    Inserting Accents.
  575. * afourlatex:                            A4 Paper.
  576. * afourpaper:                            A4 Paper.
  577. * alias:                                 alias.
  578. * anchor:                                anchor.
  579. * appendix:                              unnumbered & appendix.
  580. * appendixsec:                           unnumberedsec appendixsec heading.
  581. * appendixsection:                       unnumberedsec appendixsec heading.
  582. * appendixsubsec:                        unnumberedsubsec appendixsubsec subheading.
  583. * appendixsubsubsec:                     subsubsection.
  584. * apply:                                 Sample Function Definition.
  585. * asis:                                  table.
  586. * author:                                title subtitle author.
  587. * b (bold font):                         Fonts.
  588. * buffer-end:                            Def Cmd Template.
  589. * bullet:                                bullet.
  590. * bye <1>:                               Ending a File.
  591. * bye:                                   File End.
  592. * c (comment):                           Comments.
  593. * cartouche:                             cartouche.
  594. * center:                                titlefont center sp.
  595. * centerchap:                            chapter.
  596. * chapheading:                           majorheading & chapheading.
  597. * chapter:                               chapter.
  598. * cindex:                                Indexing Commands.
  599. * cite:                                  cite.
  600. * clear:                                 ifset ifclear.
  601. * code:                                  code.
  602. * columnfractions:                       Multitable Column Widths.
  603. * command:                               command.
  604. * comment:                               Comments.
  605. * contents:                              Contents.
  606. * copyright <1>:                         Copyright & Permissions.
  607. * copyright:                             copyright symbol.
  608. * cropmarks:                             Cropmarks and Magnification.
  609. * defcodeindex:                          New Indices.
  610. * defcv:                                 Abstract Objects.
  611. * deffn:                                 Functions Commands.
  612. * deffnx:                                deffnx.
  613. * defindex:                              New Indices.
  614. * definfoenclose:                        definfoenclose.
  615. * defivar:                               Abstract Objects.
  616. * defmac:                                Functions Commands.
  617. * defmethod:                             Abstract Objects.
  618. * defop:                                 Abstract Objects.
  619. * defopt:                                Variables Commands.
  620. * defspec:                               Functions Commands.
  621. * deftp:                                 Data Types.
  622. * deftypefn:                             Typed Functions.
  623. * deftypefun:                            Typed Functions.
  624. * deftypeivar:                           Abstract Objects.
  625. * deftypeop:                             Abstract Objects.
  626. * deftypevar:                            Typed Variables.
  627. * deftypevr:                             Typed Variables.
  628. * defun:                                 Functions Commands.
  629. * defvar:                                Variables Commands.
  630. * defvr:                                 Variables Commands.
  631. * Development/Docs/Texinfo Customize group: Texinfo Mode Printing.
  632. * dfn:                                   dfn.
  633. * dircategory:                           Installing Dir Entries.
  634. * direntry:                              Installing Dir Entries.
  635. * display:                               display.
  636. * dmn:                                   dmn.
  637. * documentencoding:                      documentencoding.
  638. * documentlanguage:                      documentlanguage.
  639. * dotaccent:                             Inserting Accents.
  640. * dotless:                               Inserting Accents.
  641. * dots:                                  dots.
  642. * email:                                 email.
  643. * emph:                                  emph & strong.
  644. * end <1>:                               Quotations and Examples.
  645. * end:                                   Introducing Lists.
  646. * end titlepage:                         end titlepage.
  647. * enddots:                               dots.
  648. * enumerate:                             enumerate.
  649. * env:                                   env.
  650. * equiv:                                 Equivalence.
  651. * error:                                 Error Glyph.
  652. * evenfooting:                           Custom Headings.
  653. * evenheading:                           Custom Headings.
  654. * everyfooting:                          Custom Headings.
  655. * everyheading:                          Custom Headings.
  656. * example:                               example.
  657. * exampleindent:                         exampleindent.
  658. * exclamdown:                            Inserting Accents.
  659. * exdent:                                exdent.
  660. * expansion:                             expansion.
  661. * file:                                  file.
  662. * filll:                                 Copyright & Permissions.
  663. * finalout:                              Overfull hboxes.
  664. * findex:                                Indexing Commands.
  665. * flushleft:                             flushleft & flushright.
  666. * flushright:                            flushleft & flushright.
  667. * foobar:                                Optional Arguments.
  668. * footnote:                              Footnotes.
  669. * footnotestyle:                         Footnote Styles.
  670. * format:                                format.
  671. * forward-word:                          Def Cmd Template.
  672. * ftable:                                ftable vtable.
  673. * group:                                 group.
  674. * H:                                     Inserting Accents.
  675. * hbox:                                  Overfull hboxes.
  676. * heading:                               unnumberedsec appendixsec heading.
  677. * headings:                              headings on off.
  678. * headword:                              definfoenclose.
  679. * html:                                  Raw Formatter Commands.
  680. * hyphenation:                           - and hyphenation.
  681. * i (italic font):                       Fonts.
  682. * ifclear:                               ifset ifclear.
  683. * ifhtml <1>:                            Conditional Commands.
  684. * ifhtml:                                Raw Formatter Commands.
  685. * ifinfo:                                Conditional Commands.
  686. * ifnothtml:                             Conditional Not Commands.
  687. * ifnotinfo:                             Conditional Not Commands.
  688. * ifnottex:                              Conditional Not Commands.
  689. * ifset:                                 ifset ifclear.
  690. * iftex:                                 Conditional Commands.
  691. * ignore:                                Comments.
  692. * image:                                 Images.
  693. * include:                               Using Include Files.
  694. * Info-validate:                         Running Info-Validate.
  695. * inforef:                               inforef.
  696. * input (TeX command):                   Minimum.
  697. * isearch-backward:                      deffnx.
  698. * isearch-forward:                       deffnx.
  699. * item <1>:                              itemize.
  700. * item <2>:                              Multitable Rows.
  701. * item:                                  table.
  702. * itemize:                               itemize.
  703. * itemx:                                 itemx.
  704. * kbd:                                   kbd.
  705. * kbdinputstyle:                         kbd.
  706. * key:                                   key.
  707. * kindex:                                Indexing Commands.
  708. * l:                                     Inserting Accents.
  709. * L:                                     Inserting Accents.
  710. * lisp:                                  lisp.
  711. * lowersections:                         Raise/lower sections.
  712. * macro:                                 Defining Macros.
  713. * mag (TeX command):                     Cropmarks and Magnification.
  714. * majorheading:                          majorheading & chapheading.
  715. * makeinfo-buffer:                       makeinfo in Emacs.
  716. * makeinfo-kill-job:                     makeinfo in Emacs.
  717. * makeinfo-recenter-output-buffer:       makeinfo in Emacs.
  718. * makeinfo-region:                       makeinfo in Emacs.
  719. * math:                                  math.
  720. * menu:                                  Menus.
  721. * minus:                                 minus.
  722. * multitable:                            Multi-column Tables.
  723. * need:                                  need.
  724. * next-error:                            makeinfo in Emacs.
  725. * node:                                  node.
  726. * noindent:                              noindent.
  727. * novalidate:                            Format with tex/texindex.
  728. * O:                                     Inserting Accents.
  729. * o:                                     Inserting Accents.
  730. * occur:                                 Using occur.
  731. * occur-mode-goto-occurrence:            Showing the Structure.
  732. * oddfooting:                            Custom Headings.
  733. * oddheading:                            Custom Headings.
  734. * oe:                                    Inserting Accents.
  735. * OE:                                    Inserting Accents.
  736. * option:                                option.
  737. * page:                                  page.
  738. * page, within @titlepage:               titlepage.
  739. * pagesizes:                             pagesizes.
  740. * paragraphindent:                       paragraphindent.
  741. * phoo:                                  definfoenclose.
  742. * pindex:                                Indexing Commands.
  743. * point:                                 Point Glyph.
  744. * pounds:                                pounds.
  745. * print:                                 Print Glyph.
  746. * printindex:                            Printing Indices & Menus.
  747. * pxref:                                 pxref.
  748. * questiondown:                          Inserting Accents.
  749. * quotation:                             quotation.
  750. * r (Roman font):                        Fonts.
  751. * raisesections:                         Raise/lower sections.
  752. * ref:                                   ref.
  753. * refill:                                Refilling Paragraphs.
  754. * result:                                result.
  755. * ringaccent:                            Inserting Accents.
  756. * rmacro:                                Defining Macros.
  757. * samp:                                  samp.
  758. * sc (small caps font):                  Smallcaps.
  759. * section:                               section.
  760. * set:                                   ifset ifclear.
  761. * setchapternewpage:                     setchapternewpage.
  762. * setcontentsaftertitlepage:             Contents.
  763. * setfilename:                           setfilename.
  764. * setshortcontentsaftertitlepage:        Contents.
  765. * settitle:                              settitle.
  766. * shortcontents:                         Contents.
  767. * shorttitlepage:                        titlepage.
  768. * smallbook:                             smallbook.
  769. * smalldisplay <1>:                      display.
  770. * smalldisplay:                          small.
  771. * smallexample:                          small.
  772. * smallformat <1>:                       small.
  773. * smallformat:                           format.
  774. * smalllisp:                             small.
  775. * sp (line spacing):                     sp.
  776. * sp (titlepage line spacing):           titlefont center sp.
  777. * ss:                                    Inserting Accents.
  778. * strong:                                emph & strong.
  779. * subheading:                            unnumberedsubsec appendixsubsec subheading.
  780. * subsection:                            subsection.
  781. * subsubheading:                         subsubsection.
  782. * subsubsection:                         subsubsection.
  783. * subtitle:                              title subtitle author.
  784. * summarycontents:                       Contents.
  785. * syncodeindex:                          syncodeindex.
  786. * synindex:                              synindex.
  787. * t (typewriter font):                   Fonts.
  788. * tab:                                   Multitable Rows.
  789. * table:                                 Two-column Tables.
  790. * tex:                                   Raw Formatter Commands.
  791. * tex (command):                         tex.
  792. * texinfo-all-menus-update:              Updating Commands.
  793. * texinfo-every-node-update:             Updating Commands.
  794. * texinfo-format-buffer <1>:             texinfo-format commands.
  795. * texinfo-format-buffer:                 Info Formatting.
  796. * texinfo-format-region <1>:             texinfo-format commands.
  797. * texinfo-format-region <2>:             Info Formatting.
  798. * texinfo-format-region:                 texinfo-format commands.
  799. * texinfo-indent-menu-description:       Other Updating Commands.
  800. * texinfo-insert-@code:                  Inserting.
  801. * texinfo-insert-@dfn:                   Inserting.
  802. * texinfo-insert-@end:                   Inserting.
  803. * texinfo-insert-@example:               Inserting.
  804. * texinfo-insert-@item:                  Inserting.
  805. * texinfo-insert-@kbd:                   Inserting.
  806. * texinfo-insert-@node:                  Inserting.
  807. * texinfo-insert-@noindent:              Inserting.
  808. * texinfo-insert-@samp:                  Inserting.
  809. * texinfo-insert-@table:                 Inserting.
  810. * texinfo-insert-@var:                   Inserting.
  811. * texinfo-insert-braces:                 Inserting.
  812. * texinfo-insert-node-lines:             Other Updating Commands.
  813. * texinfo-make-menu:                     Updating Commands.
  814. * texinfo-master-menu:                   Updating Commands.
  815. * texinfo-multiple-files-update:         texinfo-multiple-files-update.
  816. * texinfo-multiple-files-update (in brief): Other Updating Commands.
  817. * texinfo-sequential-node-update:        Other Updating Commands.
  818. * texinfo-show-structure <1>:            Using texinfo-show-structure.
  819. * texinfo-show-structure:                Showing the Structure.
  820. * texinfo-start-menu-description:        Inserting.
  821. * texinfo-tex-buffer:                    Printing.
  822. * texinfo-tex-print:                     Printing.
  823. * texinfo-tex-region:                    Printing.
  824. * texinfo-update-node:                   Updating Commands.
  825. * thischapter:                           Custom Headings.
  826. * thischaptername:                       Custom Headings.
  827. * thisfile:                              Custom Headings.
  828. * thispage:                              Custom Headings.
  829. * thistitle:                             Custom Headings.
  830. * tieaccent:                             Inserting Accents.
  831. * tindex:                                Indexing Commands.
  832. * title:                                 title subtitle author.
  833. * titlefont:                             titlefont center sp.
  834. * titlepage:                             titlepage.
  835. * today:                                 Custom Headings.
  836. * top (@-command):                       makeinfo top command.
  837. * u:                                     Inserting Accents.
  838. * ubaraccent:                            Inserting Accents.
  839. * udotaccent:                            Inserting Accents.
  840. * unmacro:                               Defining Macros.
  841. * unnumbered:                            unnumbered & appendix.
  842. * unnumberedsec:                         unnumberedsec appendixsec heading.
  843. * unnumberedsubsec:                      unnumberedsubsec appendixsubsec subheading.
  844. * unnumberedsubsubsec:                   subsubsection.
  845. * up-list:                               Inserting.
  846. * uref:                                  uref.
  847. * url:                                   url.
  848. * v:                                     Inserting Accents.
  849. * value:                                 set value.
  850. * var:                                   var.
  851. * vindex:                                Indexing Commands.
  852. * vskip:                                 Copyright & Permissions.
  853. * vtable:                                ftable vtable.
  854. * w (prevent line break):                w.
  855. * xref:                                  xref.
  856. * { (single {):                          Inserting Braces.
  857. * } (single }):                          Inserting Braces.
  858. * ~:                                     Inserting Accents.
  859.  
  860.